/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.causeway.applib.services.i18n;

import java.util.List;

/**
 * Locates and return translations.
 *
 * <p>
 * This is one of the supporting services that work together to implement
 * the framework's support for i18n, being used by the default implementation
 * {@link TranslationService}.
 * </p>
 *
 * @since 1.x {@index}
 */
public interface TranslationsResolver {

    /**
     * Reads the lines from the specified &quot;logical&quot; file name.
     *
     * <p>
     *     It is the responsibility of {@link TranslationsResolver} to determine
     *     where the file actually resides (the data could be read from a
     *     database, for example, rather than an actual file.
     * </p>
     *
     * @param file
     */
    List<String> readLines(final String file);

}
